Deploy GitHub pages from GitHub actions with Sphinx#489
Open
fdxmw wants to merge 9 commits into
Open
Conversation
… actions with Sphinx. This replaces the old `gh-pages` branch workflow, and generates the HTML with Sphinx so we don't have to manually edit HTML. GitHub Pages' `index.html` is now generated from `www/index.rst`, which is much easier to edit. Sphinx automatically runs from GitHub actions when changes are pushed to `www/`. Also: * Added simulation scripts to all GitHub pages code samples. * Moved the larger code samples to external `.py` files so `ruff` can auto-format them and check them for lint. * Added many type hints. * Added many PyRTL documentation and example links. * Fixed many typos. * Upgraded some GitHub actions workflows. * Remove Sphinx version information and copyright from documentation footers.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## development #489 +/- ##
===========================================
Coverage 92.1% 92.1%
===========================================
Files 30 30
Lines 7438 7438
===========================================
Hits 6849 6849
Misses 589 589 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
* Test `www` examples. * Update READMEs.
…h and improve formatting.
…ate. Increase resolution for all screenshots.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR significantly changes PyRTL's GitHub Pages workflow. This will also change the appearance of http://ucsbarchlab.github.io/PyRTL, a preview is available at https://fdxmw.github.io/PyRTL/
This replaces the old
gh-pagesbranch workflow, and generates the HTML with Sphinx so we don't have to manually edit HTML. GitHub Pages'index.htmlis now generated fromwww/index.rst, which is much easier to edit. Sphinx automatically runs from GitHub actions when changes are pushed towww/.Also:
Added simulation scripts to all GitHub pages code samples.
Moved the larger code samples to external
.pyfiles soruffcan auto-format them and check them for lint.Added many type hints.
Added many PyRTL documentation and example links.
Fixed many typos.
Upgraded some GitHub actions workflows.
Remove Sphinx version information and copyright from documentation footers.